// The NSpring Framework for .NET
// Copyright (c) 2003, Jeffrey Varszegi
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without modification, 
// are permitted provided that the following conditions are met:
// 
// - Redistributions of source code must retain the above copyright notice, this 
// list of conditions and the following disclaimer.
// 
// - Redistributions in binary form must reproduce the above copyright notice, this 
// list of conditions and the following disclaimer in the documentation and/or other 
// materials provided with the distribution.
// 
// - Neither the name of the NSpring project nor the names of its contributors may 
// be used to endorse or promote products derived from this software without 
// specific prior written permission from the copyright owner.
// 
// - No product derived from this software may be called "NSpring", nor may 
// "NSpring" appear in the name of such a product, without specific prior written 
// permission from the copyright owner.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
// OF THE POSSIBILITY OF SUCH DAMAGE. 

namespace NSpring.Logging.Common.Pattern {

using System;
using System.Text;

using NSpring.Logging;

/// <summary>
/// <para>
/// An event-formatting pattern.  
/// All underlying pattern-related code is subject to change without warning
/// or deprecation, and should not be called directly by application code
/// </para>
/// </summary>
internal abstract class Pattern {
    protected string source;
    protected Token[] tokens;
    
    private Pattern() {}

    protected Pattern(string _source) : this(_source, true, true, true, true, true) {}
    
    protected Pattern(string _source, bool _isContextPropertyEnabled, bool _isEventPropertyEnabled, bool _isEventEnabled, bool _isMessageEnabled, bool _isDataEnabled) {
        if (_source == null) {
            throw new ArgumentNullException();
        }
        source = _source;
        tokens = (new PatternParser(_isContextPropertyEnabled, _isEventPropertyEnabled, _isEventEnabled, _isMessageEnabled, _isDataEnabled)).Parse(source);
    }
    
    protected Pattern(string _source, bool _isContextPropertyEnabled, bool _isEventPropertyEnabled, bool _isEventEnabled, bool _isMessageEnabled, bool _isDataEnabled, char[] _separators) {
        if (_source == null) {
            throw new ArgumentNullException();
        }
        source = _source;
        tokens = (new PatternParser(_isContextPropertyEnabled, _isEventPropertyEnabled, _isEventEnabled, _isMessageEnabled, _isDataEnabled, _separators)).Parse(source);
    }
    
    public string Source {
        get {
            return source;
        }
    }
    
    public Token[] Tokens {
        get {
            Token[] returnValue = new Token[tokens.Length];
            Array.Copy(tokens, 0, returnValue, 0, tokens.Length);
            return returnValue;
        }
    }
    
    public abstract string Format(Event e);
    public abstract void Format(Event e, StringBuilder sb);
    
}

}
